home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_xemacs.idb / usr / freeware / lib / xemacs-20.4 / etc / BETA.z / BETA
Encoding:
Text File  |  1998-05-21  |  11.7 KB  |  313 lines
  1.                 -*- mode:outline; minor-mode:outl-mouse -*-
  2.  
  3. * Introduction
  4. ==============
  5.  
  6. You are running an experimental version of XEmacs.  Please do not
  7. report problems with Beta XEmacs to comp.emacs.xemacs.  Report them to
  8. xemacs-beta@xemacs.org.
  9.  
  10. ** XEmacs Beta Mailing List
  11. ===========================
  12.  
  13. *** Subscribing
  14. ---------------
  15.  
  16. If you are not subscribed to the XEmacs beta list you should be.  Send
  17. an email message with a subject of `subscribe' (without the quotes) to
  18. xemacs-beta-request@xemacs.org and follow the directions.  You do not
  19. have to fill out the survey if you don't want to.
  20.  
  21. *** Unsubscribing
  22. -----------------
  23.  
  24. To unsubscribe from the list send an email message with a subject of
  25. `unsubscribe' (without the quotes) to xemacs-beta-request@xemacs.org.
  26.  
  27. *** Administrivia
  28. -----------------
  29.  
  30. The XEmacs beta list is managed by the SmartList mailing list package,
  31. and the usual SmartList commands work.  Do not send mailing list
  32. requests to the main address (xemacs-beta@xemacs.org), always send
  33. them to xemacs-beta-request@xemacs.org.  If you have problems with the
  34. list itself, they should be brought to the attention of the XEmacs
  35. Mailing List manager Steve Baur <steve@xemacs.org>.
  36.  
  37.  
  38. ** Beta Release Schedule
  39. ========================
  40.  
  41. The URL ftp://ftp.xemacs.org/pub/beta/README always contains the best
  42. estimate of when the next beta XEmacs will be released.  For weekend
  43. betas the release time is generally in the vicinity of 2PM to 5PM US
  44. Pacific Time (Universal Time minus 8 hours).  For weekday betas, the
  45. release time is generally in the vicinity of 8PM to Midnight US
  46. Pacific Time on the listed day.
  47.  
  48. Betas are nominally a week apart, scheduled on every Saturday.
  49. Midweek releases are made when a serious enough problem warrants it.
  50.  
  51.  
  52. ** Reporting Problems
  53. =====================
  54.  
  55. The best way to get problems fixed in XEmacs is to submit good problem
  56. reports.  Since this is beta software, problems are certain to exist.
  57. Please read through all of part II of the XEmacs FAQ for an overview
  58. of problem reporting.  Other items which are most important are:
  59.  
  60. 1.  Do not submit C stack backtraces without line numbers.  Since it
  61.     is possible to compile optimized with debug information with GCC
  62.     it is never a good idea to compile XEmacs without the -g flag.
  63.     XEmacs runs on a variety of platforms, and often it is not
  64.     possible to recreate problems which afflict a specific platform.
  65.     The line numbers in the C stack backtrace help isolate where the
  66.     problem is actually occurring.
  67.  
  68. 2.  Attempt to recreate the problem starting with an invocation of
  69.     XEmacs with `xemacs -vanilla'.  Quite often, problems are
  70.     due to package interdependencies, and the like.  An actual bug in
  71.     XEmacs should be reproducible in a default configuration without
  72.     loading any special packages (or the one or two specific packages
  73.     that cause the bug to appear).
  74.  
  75. 3.  A picture can be worth a thousand words.  When reporting an
  76.     unusual display, it is generally best to capture the problem in a
  77.     screen dump and include that with the problem report.  The easiest
  78.     way to get a screen dump is to use the xv program and its grab
  79.     function.  Save the image as a GIF to keep bandwidth requirements
  80.     down without loss of information.  MIME is the preferred method
  81.     for making the image attachments.
  82.  
  83. * Compiling Beta XEmacs
  84. =======================
  85.  
  86. ** Building an XEmacs from patches
  87. ==================================
  88.  
  89. All beta releases of XEmacs are included with patches from the
  90. previous version in an attempt to keep bandwidth requirements down.
  91. Patches should be applied with the GNU patch program in something like
  92. the following.  Let's say you're upgrading XEmacs 20.4-beta10 to
  93. XEmacs 20.4-beta11 and you have a full unmodified XEmacs 20.4-beta10
  94. source tree to work with.  Cd to the top level directory and issue the
  95. shell command:
  96.  
  97. $ gunzip -c /tmp/xemacs-20.4-b10-20.4-b11.patch.gz | patch -p1
  98.  
  99. After patching, check to see that no patches were missed by doing
  100. $ find . -name \*.rej -print
  101.  
  102. Any rejections should be treated as serious problems to be resolved
  103. before building XEmacs.
  104.  
  105. After seeing that there were no rejections, issue the commands
  106.  
  107. $ ./config.status --recheck
  108. $ make beta
  109.  
  110. and go play minesweep for a while on an older XEmacs while the binary
  111. is rebuilt.
  112.  
  113. ** Building XEmacs from a full distribution
  114. ==============================================
  115.  
  116. Locate a convenient place where you have at least 100MB of free space
  117. and issue the command
  118.  
  119. $ gunzip -c /tmp/xemacs-20.4-b11.tar.gz | tar xvf -
  120.  
  121. (or simply `tar zxvf /tmp/xemacs-20.4-b11.tar.gz' if you use GNU tar).
  122.  
  123. cd to the top level directory and issue an appropriate configure
  124. command.  One maintainer uses the following at the time of this
  125. writing:
  126.  
  127. ./configure \
  128.     --cflags="-m486 -g -O4 -fno-strength-reduce -malign-loops=2 \
  129.           -malign-jumps=2 -malign-functions=2" \
  130.         --with-sound=no --with=offix \
  131.     --error-checking=all --debug=yes \
  132.     --with-scrollbars=athena3d --with-dialogs=athena3d \
  133.     --with-mule --with-canna --with-wnn
  134.  
  135. Part of the configure output is a summary that looks something like:
  136.  
  137. Configured for `i586-unknown-linux2.0.28'.
  138.  
  139.   Where should the build process find the source code?    /usr/src/xemacs-20.4
  140.   What installation prefix should install use?            /usr/local
  141.   Where should XEmacs look for packages?          ~/.xemacs:/usr/local/lib/xemacs/packages
  142.   What operating system and machine description files should XEmacs use?
  143.         `s/linux.h' and `m/intel386.h'
  144.   What compiler should XEmacs be built with?              gcc -m486 -g -O4 -fno-strength-reduce -malign-loops=2 -malign-jumps=2 -malign-functions=2
  145.   Should XEmacs use the GNU version of malloc?            yes
  146.   Should XEmacs use the relocating allocator for buffers? yes
  147.   What window system should XEmacs use?                   x11
  148.   Where do we find X Windows header files?                /usr/X11R6/include
  149.   Where do we find X Windows libraries?                   /usr/X11R6/lib
  150.   Compiling in support for XAUTH.
  151.   Compiling in support for GIF image conversion.
  152.   Compiling in support for XPM images.
  153.   Compiling in support for X-Face message headers.
  154.   Compiling in support for JPEG image conversion.
  155.   Compiling in support for PNG image conversion.
  156.   Compiling in support for TIFF image conversion (not implemented).
  157.   Compiling in support for Berkeley DB.
  158.   Compiling in support for GNU DBM.
  159.   Compiling in Mule (multi-lingual) support.
  160.   Compiling in support for the WNN input method on Mule.
  161.     Using WNN version 6.
  162.   Compiling in support for OffiX.
  163.   Using the Lucid menubar.
  164.   Using the Athena-3d scrollbar.
  165.   Using the Athena-3d dialog boxes.
  166.  
  167. Then type `make; make finder' and you should have a working XEmacs.
  168.  
  169. After you have verified that you have a functional editor, fire up
  170. your favorite mail program and send a build report to
  171. xemacs-beta@xemacs.org.  The build report should include
  172.  
  173. 1. Your hardware configuration (OS version, etc.)
  174.  
  175. 2. Version numbers of software in use (X11 version, system library
  176.    versions if appropriate, graphics library versions if appropriate).
  177.    If you're on a system like Linux, include all the version numbers
  178.    you can because chances are it makes a difference.
  179.  
  180. 3. The options given to configure
  181.  
  182. 4. The configuration report illustrated above
  183.  
  184.    For convenience all of the above items are placed in a file called
  185.    `Installation' in the top level build directory.
  186.  
  187. 5. Any other unusual items you feel should be brought to the attention
  188.    of the developers.
  189.  
  190. ** Creating patches for submission
  191. ==================================
  192.  
  193. When making patches you should use the `-c' option, or preferably, if
  194. your diff supports it, `-u'.  Using ordinary (context-free) diffs are
  195. notoriously prone to error, since line numbers tend to change when
  196. others make changes to the same source file.
  197.  
  198. $ diff -u old-file.c new-file.c
  199.  
  200. -or-
  201.  
  202. $ diff -c old-file.c new-file.c
  203.  
  204. Also, it is helpful if you create the patch in the top level of the
  205. XEmacs source directory:
  206.  
  207. $ cp -p lwlib/xlwmenu.c lwlib/xlwmenu.c.orig
  208.   hack, hack, hack....
  209. $ diff -u lwlib/xlwmenu.c.orig lwlib/xlwmenu.c
  210.  
  211. It is preferrable for patches to be accompanied by an update (raw
  212. entry preferred) to the appropriate ChangeLog file.
  213.  
  214. Also note that if you cut & paste from an xterm to an XEmacs mail buffer
  215. you will probably lose due to tab expansion.  The best thing to do is
  216. to use an XEmacs shell buffer to run the diff commands, or ...
  217. M-x cd to the appropriate directory, and issue the command `C-u M-!' from
  218. within XEmacs.
  219.  
  220. * XEmacs 20.4 packages
  221.  
  222. XEmacs 20.4 has added the concept of installable packages searched prior
  223. to dump time when building.
  224.  
  225. Packages are searched by default under /usr/local/lib/xemacs/packages/.
  226. The summary message in configure will tell you where XEmacs is looking 
  227. for them.  The packages hierarchy differs from site-lisp in that you
  228. do not have to install XEmacs to use it.  Indeed, the package path is
  229. searched prior to dump time so that installed packages have the same
  230. status as lisp distributed in the xemacs core tarball.
  231.  
  232. The structure of each directory in the package search path should look
  233. like the base installed directory (ie. have etc/, info/, and lisp/,).
  234. Lisp is searched recursively.  It and all subdirectories are added to
  235. the `load-path'.  Each etc directory is added to `data-directory-list',
  236. and each info directory is added to `Info-default-directory-list'.
  237.  
  238. A `find . -type d -print' in my top-level package directory reveals:
  239. ./etc
  240. ./etc/auctex
  241. ./etc/auctex/style
  242. ./etc/gnus
  243. ./etc/skk
  244. ./etc/gnusrefcard
  245. ./etc/smilies
  246. ./etc/message
  247. ./info
  248. ./lisp
  249. ./lisp/gnus
  250. ./lisp/auctex
  251. ./lisp/auctex/man
  252. ./lisp/footnote
  253. ./lisp/skk
  254.  
  255.  
  256. AUCTeX and Gnus have package tarballs in
  257.     ftp://ftp.xemacs.org/pub/beta/packages-20.4/
  258. that you can simply untar in a package directory to install.
  259.  
  260. Karl Hegbloom has a set of packages in
  261.     [sorry - reference has been lost]
  262. that work the same way.
  263.  
  264. ** Packages directory on the FTP Site
  265. =====================================
  266.  
  267. The packages directory
  268.     ftp://ftp.xemacs.org/pub/xemacs/beta/packages-20.4/
  269.  
  270. is divided into subdirectory by the major type of package.
  271.  
  272. drwxr-xr-x   2 beta-f   beta-f      1024 Oct 10 00:43 binary-packages
  273. drwxr-xr-x   2 beta-f   beta-f       512 Oct 10 00:44 package-sources
  274. drwxr-xr-x   2 beta-f   beta-f       512 Oct  9 23:08 single-file-packages
  275. drwxr-xr-x   2 beta-f   beta-f       512 Oct 10 00:44 utils
  276.  
  277. ** Support Utilities (utils)
  278. ============================
  279.  
  280. The utils directory contains tools to deal with current Lisp sources that
  281. have not had yet gotten XEmacs package integration.  The script `xpackage.sh'
  282. is used with Quassia Gnus.  Edit the appropriate variables at the top of
  283. the script to reflect the local configuration and run it in the top level
  284. directory of a Quassia Gnus source tree to install an update to Quassia Gnus.
  285.  
  286. ** Source Installable Packages (package-sources)
  287. ================================================
  288.  
  289. This directory contains tarballs of Lisp packages that contain full support
  290. for installing as an XEmacs package.  To install them, one should untar
  291. them to someplace convenient (like /var/tmp), and issue the appropriate make
  292. command to install.
  293.  
  294. ** Binary package installation (binary-packages)
  295. ================================================
  296.  
  297. Prerequisite:  XEmacs 20.3-beta28.
  298.  
  299. Binary packages are complete entities that can be untarred at the top
  300. level of an XEmacs package hierarchy and work at runtime.  To install files
  301. in this directory, run the command `M-x package-admin-add-binary-package'
  302. and fill in appropriate values to the prompts.
  303.  
  304. ** Single file package installation
  305. ===================================
  306.  
  307. Prerequisite:  XEmacs 20.3-beta28.
  308.  
  309. These are single file, self-contained lisp packages that don't need a
  310. separate directory.  To install something from this directory, run
  311. the command `M-x package-admin-add-single-file-package' and fill in the
  312. prompts.
  313.